home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / aqbbs807.zip / ALPHQBBS.DOC < prev    next >
Text File  |  1989-02-26  |  53KB  |  1,282 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.              ***   *         *               ***   ****   ****    *** 
  12.             *   *  *         *              *   *  *   *  *   *  *
  13.             *****  *  ****   ****    *** *  *   *  ****   ****    *** 
  14.             *   *  *  *   *  *   *  *   **  * * *  *   *  *   *      *
  15.             *   *  *  ****   *   *   *** *   ***   ****   ****    *** 
  16.                       *                        * 
  17.                       *    
  18.  
  19.  
  20.                            Version 7.00  (7.01 gamma)                   
  21.  
  22.  
  23.  
  24.         The first artificially intelligent file area maintenance utility
  25.  
  26.  
  27.         Copyright (C) 1989 by \/isions software
  28.  
  29.  
  30.         AlphaQBBS is Copyright (C) 1988,1989 by K-Tech Computers
  31.               
  32.  
  33.         Vsort is Copyright (C) 1989 by \/Soft corp.
  34.  
  35.  
  36.         AlphaSetup is Copyright (C) 1989 by \/Soft corp.
  37.  
  38.  
  39.         This document is Copyright (C) 1989 by \/isions software
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                    1
  62.  
  63.  
  64.  
  65.         Contents of these documents:
  66.         ----------------------------
  67.  
  68.              Section                                              Page
  69.         -----------------------------------------------------------------
  70.  
  71.         1.0  Preface by Jason Froikin............................  3
  72.  
  73.  
  74.         1.1  Preface by David Kuhn...............................  3 -  4     
  75.  
  76.  
  77.         2.0  About AlphaQBBS.....................................  4 -  5
  78.  
  79.  
  80.         3.0  Setup...............................................  5 - 10
  81.  
  82.             
  83.         3.1  Structure of the Control File....................... 11
  84.  
  85.  
  86.         4.0  System Requirements for Operation................... 12
  87.  
  88.              
  89.         4.1  Limitations......................................... 12
  90.  
  91.  
  92.         4.2  Operation of AlphaQBBS.............................. 12 - 13
  93.  
  94.  
  95.         4.3  Command Line Parameters............................. 13
  96.  
  97.  
  98.         4.4  Available Command Line Parameters................... 14 - 17
  99.  
  100.  
  101.         4.5  Expiration Date Explained........................... 17
  102.  
  103.  
  104.         5.0  Error Table......................................... 18
  105.  
  106.  
  107.         6.0  Registration Information............................ 19
  108.  
  109.  
  110.         7.0  Warranties, Licensing, etc.......................... 19
  111.  
  112.  
  113.         8.0  Credits............................................. 19 - 20
  114.  
  115.  
  116.              Registration Form................................... 21
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                Page 2
  123.  
  124.  
  125.  
  126.         =================================================================
  127.         Section 1: Preface (Why!) by Jason Froikin
  128.         =================================================================
  129.  
  130.         I recently opened a BBS in early December of 1988. Shortly there-
  131.         after, I discovered that none of the file area maintenance  util-
  132.         ities, that piled up, sorted the file areas as I wanted them  to.  
  133.         So,  you know how the saying goes, if you want it done right,  do 
  134.         it  yourself.  And low and behold, with help from David  Kuhn,  I 
  135.         had  an artificially intelligent file area sorter that  could  be 
  136.         conscious  of  where headers, blank lines, and file  names  were.  
  137.         Sound like science fiction?  Well, hello Star Trek, the future is 
  138.         here.
  139.  
  140.         It seemed that ,at the time, there was this great file area util-
  141.         ity  called  AlphaQBBS made by Dave. So I decided that  the  best 
  142.         should  go  to  the best!  Low and  behold  (heard  that  before) 
  143.         AlphaQBBS  5.0,  the first AlphaQBBS program, the  first  program 
  144.         period,  that included my artificially intelligent  file  sorting 
  145.         utility, came into being.
  146.  
  147.         What have we got now, you might ask.  My answer is obviously  THE 
  148.         best  and  most intelligent file area sorter  and  overall  files 
  149.         lister in the shareware market!
  150.  
  151.         =================================================================
  152.         Section 1.1: Preface (Why!) by David Kuhn
  153.         =================================================================
  154.  
  155.         I  first  started a BBS around May 15th, 1988. It hasn't  been  a 
  156.         year.  In  that time I have evaluated a number of  overall  files 
  157.         listing  utilities. None of them totally pleased me. Having  con-
  158.         trol over processes is a big satisfaction. Perhaps this is why  I 
  159.         was drawn to QuickBBS. Adam has written a fine piece of code, but 
  160.         still  allowed the sysop to have the biggest say in what  his/her 
  161.         BBS looks like. This same "craving for control" is what drives me 
  162.         write software, even if other programs exist that perform a  sim-
  163.         ilar function. Hopefully in the process, a superior program  will 
  164.         emerge.  If  not totally superior, at least one with  more  func-
  165.         tions.
  166.  
  167.         AlphaQBBS  started  life as a program that only created  a  total 
  168.         files listing. The original intent was to create an overall files 
  169.         listing  of  all the files on a given system. This  was  a  total 
  170.         files list, not one separated by file area name and title. It was 
  171.         quite  pleasing  to me create a sorting routine that  could  sort 
  172.         over  8000  files without running out of system  memory!  Anybody 
  173.         that knows me will testify that I can be quite stubborn. This  is 
  174.         all the first four revisions did.
  175.  
  176.         Now  with revision 5.0, my thought processes changed.  I  started 
  177.         listening to suggestions. Hence 5.0 can produce any form of  out-
  178.         put that my "think tank" of former users could come up with.  The 
  179.         process  of thought changed so much that I even  allowed  another 
  180.         author to write part of it! Jason Froikin created an 
  181.  
  182.  
  183.                                Page 3
  184.  
  185.  
  186.  
  187.         =================================================================
  188.         Section 1.1: Preface (Why!) by David Kuhn ...continued                         
  189.         =================================================================
  190.  
  191.         extremely  ingenious algorithm to intelligently sort any type  of 
  192.         files.bbs  listing. With a little of work, his  product  "\/sort" 
  193.         has  been incorporated in AlphaQBBS. You will find many  features 
  194.         in  this  revision that make AlphaQBBS an exciting  package  with 
  195.         fresh ideas.
  196.  
  197.         This  was  a  fun  project for me, if  not  time  consuming.  The 
  198.         "project"  hasn't ended though. AlphaQBBS will continue  to  grow 
  199.         and  evolve thanks to the many users of this product.  I'll  con-
  200.         tinue to have fun . My closing thoughts? A Philosophy to live by: 
  201.         "Don't take life so seriously. What the hey, there's always  next 
  202.         time! <Grin>" and "Thank God for spelling checkers!". Enjoy.
  203.  
  204.  
  205.         =================================================================
  206.         Section 2: About AlphaQBBS
  207.         =================================================================
  208.  
  209.         WHAT WAS AND WHAT IS:
  210.  
  211.         Since version 1.0 of AlphaQBBS was released, its sole purpose was 
  212.         to  sort a bunch of file listings and make one giant listing  out 
  213.         of it.  Versions following 1.0 were bug fixes and large increases 
  214.         of efficiency.  Gradually, AlphaQBBS became a VERY efficient file 
  215.         lister.
  216.  
  217.         BUT, that wasn't enough for us ambitious people!
  218.  
  219.         \/Sort was added into the code.  \/Sort is an artificially intel-
  220.         ligent file listing sort subprogram. This subprogram is  automat-
  221.         ically  conscious of solid headers, and blank lines, in the  file 
  222.         WITHOUT HUMAN INTERVENTION.  Hence, AlphaQBBS 5.0 was born.   The 
  223.         same  quality efficient file lister now with the ability to  sort 
  224.         the individual file listings INTELLIGENTLY.
  225.  
  226.         Jason  Froikin  of \/Soft rewrote the setup program  for  version 
  227.         6.0.  This setup program is now of an extreamly high  caliber  of 
  228.         quality ,but has once again been separated from the main body  of 
  229.         AlphaQBBS. This was done for compiler memory conciderations.
  230.  
  231.         A  \/Adopt  module has been added to version  7.0.  This  usefull 
  232.         addition allows for the adoption of orphaned files in your  BBS's 
  233.         file   list   (FILES.BBS).  If  a  file  exists  in   the   MSDOS 
  234.         subdirectory, but for some reason isn't listed in the  FILES.BBS, 
  235.         \/Adopt  will adopt that file, giving it the file discription  of 
  236.         "New  File:  Adopted by AlphaQBBS". AlphaQBBS can also  create  a 
  237.         list  of all adopted files for the use of the sysop.  A  separate 
  238.         NoAdopt.CTL  control  file can be created to  keep  \/Adopt  from 
  239.         adopting certain file names (e.g., FILES.BAK, DIR.BBS, etc.,).
  240.  
  241.  
  242.  
  243.  
  244.                                Page 4
  245.  
  246.  
  247.  
  248.         =================================================================
  249.         Section 2: About AlphaQBBS ...continued
  250.         =================================================================
  251.  
  252.         A number of other usefull and asked for features have been added. 
  253.         We're  sure that you will find this package exciting and  usefull 
  254.         in your daily BBS life.
  255.  
  256.         Sound  good?   Keep reading along, and soon you will be  able  to 
  257.         have a copy operating on your BBS.
  258.  
  259.         =================================================================
  260.         Section 3: Setup
  261.         =================================================================
  262.  
  263.         AlphaQBBS requires a control file to operate. Included along with 
  264.         ver  7.0  of  AlphaQBBS is the  setup  program  AQSETUP.EXE.  The 
  265.         purpose  of  the AQSetup program is to aid you  in  creating  the 
  266.         needed control file for operation. The structure of this  control 
  267.         file  is  explained later in these documents.  The  control  file 
  268.         ,AlphQBBS.SYS,  can be edited (or even created for that   matter) 
  269.         using your favorite ascii editor.
  270.  
  271.         To initiate Setup, type the following at the DOS command line:
  272.  
  273.              AQSETUP
  274.  
  275.         Once the vanity credit has finished you see a command line at the 
  276.         top of your screen that looks something like this:
  277.  
  278.  
  279.         \/isions  Edit      Control File: AlphQBBS.SYS    AlphaSetup 5.2
  280.         =================================================================
  281.  
  282.  
  283.         Pressing  the <LEFT> or <RIGHT> arrow keys will cause either  the 
  284.         \/isions  or the Edit to be highlighted. Selecting either  choice 
  285.         and then pressing the <DOWN> arrow key will cause a "POP-UP" menu 
  286.         to  appear. Both "POP-UP" menus are explained in  detail  further 
  287.         down.
  288.  
  289.         In  the center of the top line you should see  information  about 
  290.         the control file being used. By default, the name of the  control 
  291.         file  is  "ALPHQBBS.SYS". This can be changed by a  command  line 
  292.         parameter, explained later. 
  293.  
  294.  
  295.         <ESC> Note:  at  the  bottom  you will see  a  line  that  states      
  296.               "Press  <ESC> when finished.".  At all times in  the  setup 
  297.               mode, AlphaQBBS will have a similar message at the  bottom. 
  298.               The <ESC> key is used to `back out' of menus in AlphaSetup. 
  299.               At  this point on the start-up menu, the <ESC>  will  allow 
  300.               you to end the program run. At other points the <ESC>  will 
  301.               end processes. It doesn't necessarily cancel them.
  302.  
  303.  
  304.  
  305.                                Page 5
  306.  
  307.  
  308.  
  309.         =================================================================
  310.         Section 3: Setup ...continued                                    
  311.         =================================================================
  312.  
  313.         The \/isions Menu
  314.         =================
  315.  
  316.         The \/isions menu looks as such:
  317.  
  318.         +-------------------------------+   -> Use the <UP> and <DOWN>
  319.         |                               |      arrow keys to move a
  320.         |  Induction of FLSEARCH.CTL    |      scroll bar in order to 
  321.         |  Logo information             |      select an option.
  322.         |  Edit header - ALPHHDR.OVL    |
  323.         |  Make tagfile - Download.TAG  |   -> Pressing <ENTER> will 
  324.         |  File edit - NOADOPT.CTL      |      select then option under     
  325.         |  Command line switches        |      the scroll bar            
  326.         |  Output file name change      |                                
  327.         |  Shell to DOS                 |   -> Menu is also "Hot-Keyed". 
  328.         |  Quick AlphaSetup             |      Pressing the 1st letter on   
  329.         |                               |      the line will select that 
  330.         +-------------------------------+      option.                   
  331.                                             
  332.                                             
  333.         I(nduction): 
  334.              Read  QuickBBS's FLSEARCH.CTL file and use that  information 
  335.              to create an ALPHQBBS.SYS file. After using this option,  it 
  336.              is  probable that you will want to select the Edit  "Pop-UP" 
  337.              menu to change the default control information.
  338.  
  339.         L(ogo): 
  340.              Redisplays the Alphasetup logo and version information.
  341.  
  342.         E(dit) Header: 
  343.              This  invokes  a full screen editor in order to  change  the 
  344.              ascii file `ALPHHDR.OVL'. This is custom file that is  added 
  345.              to  the beginning of the files compilation. It  should  list 
  346.              information about you BBS.
  347.  
  348.         M(ake tagfile): 
  349.              This  invokes  a full screen editor in order to  change  the 
  350.              ascii file `DOWNLOAD.TAG'. This is a custom file that can be 
  351.              added  to  the end of the file compilation.  It  could  list 
  352.              information about you file directories.
  353.  
  354.         F(ile edit): 
  355.              This  invokes  a full screen editor in order  to  create  or 
  356.              change then ascii file `NoAdopt.CTL'. This is a custom  file 
  357.              that  AlphaQBBS  uses for the  \/Adopt  option.  NoAdopt.CTL 
  358.              should contain a list of file names that you would not  want 
  359.              AlphaQBBS  to  adopt (e.g., FILES.BBS,  FILES.BAK,  DIR.BBS, 
  360.              etc.,). More on this later.
  361.  
  362.  
  363.  
  364.  
  365.  
  366.                                Page 6
  367.  
  368.  
  369.  
  370.         =================================================================
  371.         Section 3: Setup ...continued                                    
  372.         =================================================================
  373.  
  374.         C(ommand line switches):
  375.              This  is  a list of the current command line  switches  that 
  376.              work   with  the  AQSetup  program.  These  switches   don't 
  377.              necessarily  relate to the ALPHAQBBS program  operation.  At 
  378.              present, only the -C command line parameter is supported  in 
  379.              AQSETUP.   Specifying  -Cfilename.ext  as  a  command   line 
  380.              parameter,  will allow you to create a control file  with  a 
  381.              name  other than AlphQBBS.SYS (default). Usage would  be  as 
  382.              this:
  383.                        AQSETUP -Ccustom.SYS
  384.  
  385.              This  will cause AQSETUP to created a control file with  the 
  386.              name CUSTOM.SYS. The filename and extention can be  anything 
  387.              of your choice as long as the file extension contains  three 
  388.              characters.
  389.  
  390.         O(output file name change): 
  391.              This is an alternative way to edit another control file.  If 
  392.              you start AQSETUP without the -C command line parameter  but 
  393.              in  the  process of editing the file decide  to  change  its 
  394.              name,  use  this fuction. You can choice any  name  for  the 
  395.              control  that you wish, as long as it has a three  character 
  396.              file extension.
  397.  
  398.         S(hell to DOS):
  399.              As  the name implies this fuction will drop you to DOS is  a 
  400.              "shelled"  invirionment.  This  is usefull do  look  at  the 
  401.              directory,  type  files,  etc.,.  Type  EXIT  to  return  to 
  402.              AQSetup. Dont't forget to do this!
  403.  
  404.         Q(uit): This  will  end the operation of AlphaSetup and  put  you 
  405.                 back at the operating system.
  406.  
  407.  
  408.         The Edit Menu
  409.         =============
  410.  
  411.         When  this menu is selected, information about the  control  file 
  412.         will be displayed towards the center of the screen. That  display 
  413.         can look similar to this:
  414.  
  415.                                        ---
  416.  
  417.         Displaying entry number 1
  418.         There are 19 Numbered   1 - 19
  419.  
  420.  
  421.         Directory: D:\files\area5\Files.BBS
  422.         Label....: ■■■ Test ■■■
  423.         Sort?....: Sort
  424.         Include..: Incl
  425.  
  426.  
  427.                                Page 7
  428.  
  429.  
  430.  
  431.         =================================================================
  432.         Section 3: Setup ...continued                                                                   ---
  433.         =================================================================
  434.  
  435.         The 1st line shows which entry in the control file is being  dis-
  436.         played.
  437.  
  438.         The 2nd line shows the number of entries in the control file.
  439.  
  440.         The lines 3 through 6 display the entry indicated by line #1.
  441.  
  442.                           Make-up of lines 3 through 6
  443.                           ============================
  444.              -> Line 3 indicates a path\directory\title    
  445.              -> Line 4 is a title for that file area.
  446.              -> Line 5 indicates whether the files.BBS is to be sorted.
  447.              -> Line 6 determines if this file area is to be included  in 
  448.                        the file compilation.
  449.  
  450.  
  451.         <UP><DOWN>:
  452.              The arrow keys allow you to page through the entries in  the 
  453.              control file.
  454.  
  455.         <INSERT>: 
  456.              The  insert  key  allows you to add  another  entry  to  the 
  457.              control file. AlphaSetup will automatically assign  harmless 
  458.              "NULL" information to that entry.
  459.  
  460.         <DEL>: 
  461.              The  delete  key will allow you to remove an  entry  in  the 
  462.              control  file.  Caution:  There isn't any  "Are  you  sure?" 
  463.              prompt. Press the button and the entry is gone.
  464.           
  465.         <ENTER>: 
  466.              Pressing enter will allow you to edit a selected entry. Once 
  467.              pressed, a window, such as shown below, will pop-up.
  468.  
  469.  
  470.  
  471.         +---------------------------------------+
  472.         |                                       | -> This is a hot-keyed
  473.         | Directory: None                       |    selection menu.
  474.         | Label....: None                       |
  475.         | Sort?....: Yes                        | -> To change an item,
  476.         | Include?.: Yes                        |    just press the 1st
  477.         |                                       |    letter.
  478.         +---------------------------------------+
  479.  
  480.         <D>: Pressing  `D' will allow you to enter a  subdirectory  path. 
  481.              AlphaQBBS  must  be  able to find  a  files.bbs  there.  The 
  482.              subdirectory  path  and  the name FILES.BBS  must  be  given 
  483.              (e.g., d:\Files\Area1\Files.BBS).
  484.  
  485.  
  486.  
  487.  
  488.                                Page 8
  489.  
  490.  
  491.  
  492.         =================================================================
  493.         Section 3: Setup ...continued                                    
  494.         =================================================================
  495.  
  496.         <L>: Pressing `L' allows you to assign a name to the subdirectory 
  497.              listed in this entry. IBM extended graphic characters can be 
  498.              used  (e.g.,  ■■■  New Uploads ■■■). This name  is  used  by 
  499.              AlphaQuickBBS in its mode "-3" method of operation. Refer to 
  500.              the command line parameters section of this manual  (section 
  501.              4.3).
  502.  
  503.         <S>: Pressing `S' will allow you to toggle (on/off) , whether  or 
  504.              not  you wish AlphaQBBS to sort the Files.BBS  specified  in 
  505.              this entry.
  506.  
  507.         <I>: Pressing  `I' will allow you to toggle (on/off), whether  or 
  508.              not  you wish AlphaQBBS to include this subdirectory in  the 
  509.              compiled files listing.
  510.  
  511.         <Esc>: 
  512.              When  you are finished editing this entry, press  escape  to 
  513.              backout.
  514.  
  515.         -> You  will need to perform the last few steps as many times  as 
  516.            necassary to tell AlphaQBBS all the file directories that  you 
  517.            wish to include in as given listing.
  518.  
  519.  
  520.         Command Line Parameters
  521.         =======================  
  522.  
  523.         If you wish to specify a different control file for AlphaSetup to 
  524.         edit, use the -C parameter as such:
  525.  
  526.                   ALPHQBBS SETUP -C[FileName.EXT]
  527.  
  528.         Example:  ALPHQBBS SETUP -CJASON.TST
  529.  
  530.  
  531.         AlphaSetup  will  then save the control  information  under  then 
  532.         title you chose. The file extension must be three characters.
  533.  
  534.  
  535.         The Great Idea!
  536.         ===============
  537.  
  538.         Gee!  Since I can create different control files, I can use  them 
  539.         to  create  different file listings with  AlphaQBBS!  Why  didn't 
  540.         anyone else think of this?
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.                                Page 9
  550.  
  551.  
  552.  
  553.         =================================================================
  554.         Section 3: Setup ...continued                                    
  555.         =================================================================
  556.  
  557.         Suppose  you have an adult files area and you don't wish to  have 
  558.         its  contents plastered all over the output file compilation  for 
  559.         the  world to see. For you MASTER file list, use a  control  file 
  560.         that excludes the ADULT subdirectory. Then create a control  file 
  561.         (e.g., as ADULT.SYS) that only had the adult subdirectory listed. 
  562.         When it comes time for your maintenance routines to operate,  you 
  563.         will run AQBBS at least once to create the MASTER files list  and 
  564.         then again to create just a list of what's in your adult area.
  565.  
  566.         What  a  great  idea!  Why didn't we  think  of  that?  For  more 
  567.         information  on  using AlphaQBBS with  different  control  files, 
  568.         read on.
  569.  
  570.  
  571.         ENDING SETUP
  572.         ============
  573.  
  574.         When  you  have finished making all the changes  that  you  wish, 
  575.         pressing  <Esc>  from the opening menu, will allow  you  to  exit 
  576.         AlphaSetup. The program will prompt to make sure you really  want 
  577.         to finish. Answer "Y" and AlphaSetup will automatically save  the 
  578.         changes to the control file before exiting. 
  579.  
  580.         That  is the basic operation of the setup program. It  is  really 
  581.         very  easy to operate once you see it running. You should now  be 
  582.         ready to work with ALPHAQBBS!
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.                                Page 10
  611.  
  612.  
  613.  
  614.         =================================================================
  615.         Section 3.1: Structure of the Control File:
  616.         =================================================================
  617.  
  618.         An actual line in the control file looks like this:
  619.  
  620.         D:\Files\Area3\FILES.BBS,New Uploads,!,*
  621.         ------------------------ ----------- - -
  622.                    ^                  ^      ^ ^
  623.                    |                  |      | +-- * indicates to include
  624.                                       |      |     this files.bbs in the
  625.         Path and file name of the     |      +--+  output listing.
  626.         Files.BBS                     |         | 
  627.                                  Title of File  +- ! indicates to sort  
  628.                                  Area              this files.bbs.
  629.             
  630.         Note: For the last two line parameters, if any character  appears 
  631.               other than what is indicated above, the controlled function 
  632.               will not take place.
  633.  
  634.         In the above example, we tell AlphaQBBS the path to the files.bbs 
  635.         as  indicated,  the  area  name is  New  Uploads,  we  wish  that 
  636.         files.bbs  to  be sorted, and that it is to be  included  in  the 
  637.         output  files listing. It's not that complicated. AlphaQBBS  will 
  638.         warn you and cease to operate if you make an error. No harm  will 
  639.         come.
  640.  
  641.         Your  control file will consist of any number of lines, like  the 
  642.         above (see the limitations section of this manual).
  643.  
  644.         For  those of you who have used AlphaQBBS since version 5.0,  the 
  645.         control file structure has not changed.
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.                                Page 11
  672.  
  673.  
  674.  
  675.         =================================================================
  676.         Section 4: System Requirements for Operation
  677.         =================================================================
  678.  
  679.         AlphaQBBS has these system requirements:
  680.  
  681.           - One hard or floppy disk with at least 250 Kilobytes free
  682.           - At least 256 Kilobytes of free RAM space
  683.           - MS or PC DOS version 3.0 or higher
  684.           - An IBM or fully compatible computer
  685.  
  686.         Alphaqbbs has been tested on the following computers & Software:
  687.  
  688.           - Zenith 386 with 1 megabyte of memory and hard drive, QuickBBS
  689.           - ATI 286 with 640K of memory and hard drive, QuickBBS
  690.           - Tandy 1000 with 640K memory and hard drive, QuickBBS
  691.           - Zenith 161 with 1 megabyte of memory and hard drive, QuickBBS
  692.           - Zenith 161 with 256K memory and hard drive, QuickBBS
  693.           - off a floppy drive (but why bother?), QuickBBS
  694.           - IBM (True Blue), 640K memory, hard drive, OPUS
  695.          
  696.  
  697.         =================================================================
  698.         Section 4.1: Limitations                                    
  699.         =================================================================
  700.  
  701.         No  ram-resident  clocks should be in the  system  while  running 
  702.         Alphaqbbs,  and  programs that capture the  clock  interrupt  may 
  703.         cause some problems.  Timed head parking utilities do not  effect 
  704.         the operation of Alphaqbbs. DO NOT operate shelled from any other 
  705.         environment (carrier detect considerations). If your BBS contains 
  706.         more  than  1100 file areas, or a given FILES.BBS has  more  than 
  707.         1100  line  in  it, OR your BBS has more than 8000  or  so  files 
  708.         total, forget about using this program!
  709.  
  710.         =================================================================
  711.         Section 4.2: Operation of AlphaQBBS                                    
  712.         =================================================================
  713.  
  714.         Operation  of AlphaQBBS 7.0 is relatively easy.  The minimal  you 
  715.         need for operation are these three files (same subdirectory):
  716.  
  717.          ALPHQBBS.EXE - The executable code.
  718.          ALPHHDR.OVL  - Your  text  header to go at the top of  the  file 
  719.                         compilation.
  720.          ALPHQBBS.SYS - The default AlphQBBS control file.
  721.  
  722.         -> ALPHHDR.OVL  is  the default name of the header file  that  is 
  723.            added  to the beginning of the files listing output. This  can 
  724.            be changed through a command line parameter.
  725.  
  726.         -> ALPHQBBS.SYS can be edited by an ASCII editor if you  strictly    
  727.            adhere  to  the structure, listed in section  3.1.  Using  the 
  728.            setup facility is highly suggested. Alternative control  files 
  729.            may be used. Refer to section 4.3 of this manual.
  730.  
  731.  
  732.                                Page 12
  733.  
  734.  
  735.  
  736.         =================================================================
  737.         Section 4.2: Operation of AlphaQBBS ...continued                 
  738.         =================================================================
  739.  
  740.         AlphaQBBS  can be run independently or incorporated into a  batch 
  741.         file by using the command:
  742.  
  743.            ALPHQBBS
  744.  
  745.  
  746.         -> By  default,  AlphaQBBS will produce an output  files  listing 
  747.            with the name "DOWNLOAD.TXT". This name can be changed through 
  748.            a command line parameter.
  749.  
  750.         When  AlphaQBBS  runs,  it  will look  for  a  header  file  call 
  751.         "ALPHHDR.OVL". This header file should identify your system,  its 
  752.         phone  number,  node number, etc.,. In addition, it  should  also 
  753.         have a "Title Header" line (or lines), for the start of the files 
  754.         listing.  Rather than explain this "Title Header" any further,  I 
  755.         will refer you to examine the sample "ALPHHDR.OVL" file  included 
  756.         in this package. Please edit that file for your system.
  757.  
  758.                           
  759.         =================================================================
  760.         Section 4.3: Command Line Parameters
  761.         =================================================================
  762.  
  763.         Command  line parameters allow the operation of AlphaQBBS  to  be 
  764.         modified. Without any parameters, AlphaQBBS works as follows:
  765.  
  766.  
  767.         -> Required Header File: ALPHHDR.OVL
  768.  
  769.         -> Name of Output File:  Download.TXT
  770.  
  771.         -> Type of Output: An   overall  files  listing,  no  file   area 
  772.                            reference. Good for a File Request of "Files".
  773.  
  774.         -> FILES.BBS will be sorted if indicated in the control file. 
  775.  
  776.  
  777.         To change this default operation, you must use command line  par-
  778.         ameters. An example use would be as follows:
  779.  
  780.              ALPHQBBS -FBasslope.TXT -3 
  781.  
  782.         Version  7.0 of ALPHAQBBS has a rich supply of available  command 
  783.         line  parameters to meet almost any need. Refer to the next  page 
  784.         for an explanation of the available parameters.
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.                                Page 13
  794.  
  795.  
  796.  
  797.         =================================================================
  798.         Section 4.4: Available Command Line Parameters
  799.         =================================================================
  800.  
  801.         The following command parameter can be used to spice up the oper-
  802.         ation of AlphaQBBS:
  803.  
  804.  
  805.         Parameter       | What is does
  806.         -----------------------------------------------------------------
  807.         -1  (Default)   | Standard  formatted output file. This  produces  
  808.                         | an overall sorted files listing. Program  Name,   
  809.                         | size,  file  creation  date,  and   description   
  810.                         | information is included in the output  listing.   
  811.                         | This output listing is most suited for the file   
  812.                         | that you send when your system receives a  FILE   
  813.                         | REQUEST for "FILES"
  814.                         |
  815.         -2              | Secondary  standard output file. This  produces 
  816.                         | an overall sorted files listing. Program  Name,  
  817.                         | size,  files  area,  and  file  description  is 
  818.                         | included in the output listing. This is  ident-
  819.                         | ical to the -1 option except the the file  area 
  820.                         | #  is substituted for the file creation   date. 
  821.                         | (More on this later)
  822.                         |
  823.         -3              | This produces a listing totally different  than   
  824.                         | option -1 or -2. This may be considered a  more  
  825.                         | "traditional" output format. The output listing  
  826.                         | is actually a compilation of all the  FILES.BBS  
  827.                         | that  are specified in the control file  to  be  
  828.                         | included  in the output. It is almost the  same     
  829.                         | as  tagging all the FILES.BBS together  except:  
  830.                         | File Size and creation date are listed,  output  
  831.                         | is neatly formatted, and the area title  speci-
  832.                         | fied  in the control file is used to create   a 
  833.                         | heading  for  a given FILES.BBS.  This  is  the  
  834.                         | option you will want to use to create the files  
  835.                         | listing that your users download.  
  836.                         |      
  837.         -A              | This  forces AlphaQBBS to adopt any  "Orphaned" 
  838.                         | files in the file directories indicated in  the 
  839.                         | control  file. An Orphaned file is one that  is 
  840.                         | in  the MSDOS subdirectory but not in  the  BBS 
  841.                         | files  list (Files.BBS). An associated  control 
  842.                         | file  must  exist  in  the  same  directory  as 
  843.                         | AlphaQBBS  called "NoAdopt.CTL".  This  control 
  844.                         | file  contains the names of files that  you  do 
  845.                         | not  wish AlphaQBBS to adopt (e.g.,  Files.BBS, 
  846.                         | Files.Bak,  Dir.BBS, etc.,). The  structure  of 
  847.                         | the NoAdopt.CTL file is shown in this example:
  848.                         |  
  849.                         |     FILES.BBS
  850.                         |     FILES.BAK
  851.                         |     DIR.BBS
  852.  
  853.  
  854.                                Page 14
  855.  
  856.  
  857.  
  858.         =================================================================
  859.         Section 4.4: Available Command Line Parameters ...continued      
  860.         =================================================================
  861.  
  862.                         | The NoAdopt.CTL file is ascii in nature and can 
  863.                         | be created using AqSetup or your favorite  text 
  864.                         | editor.  Only  one file name per  line  with  a 
  865.                         | <carriage Return> following it can be used.                 
  866.                         |
  867.         -Cfilename.ext  | Specify the name of an alternate control  file. 
  868.                         | This is useful if you wish to compile a list of 
  869.                         | just  one area, perhaps one of limited  access, 
  870.                         | such as adult access files.
  871.                         |
  872.         -E              | Using  this parameter will force  AlphaQBBS  to 
  873.                         | exclude  file names that are missing  from  the 
  874.                         | MSDOS  directory,  from  the  file  compilation 
  875.                         | listing. Using this option "Shows the user what 
  876.                         | we have, NOT what we want.
  877.                         |
  878.         -Ffilename.ext  | Specify  a new output file name.  The  filename 
  879.                         | must be legal and have a 3-digit extension.  Do 
  880.                         | not  use  any  spaces between the  -F  and  the 
  881.                         | filename.  If the -F parameter is not used,  by 
  882.                         | default, AlphaQBBS will create an output  files 
  883.                         | listing by the name of "DownLoad.TXT"
  884.                         |
  885.         -Hfilename.ext  | Specify  a new name for a header file,which  is 
  886.                         | added  at the beginning of the  files  listing. 
  887.                         | The  filename must be legal and have a  3-digit 
  888.                         | extension. Do not use spaces between the -H and 
  889.                         | the filename. If the -H parameter is not  used, 
  890.                         | AlphaQBBS,   by   default,   will   look    for 
  891.                         | ALPHHDR.OVL.                   
  892.                         |
  893.         -Mfilename.ext  | This  will allow AlphaQBBS to create a list  of 
  894.                         | files that were found to be missing during it's 
  895.                         | operation. Of course, AlphaQBBS will only  look 
  896.                         | in  the  directories specified in  the  control 
  897.                         | file.  The  file name is one  of  you  choosing 
  898.                         | (filename.ext), but must have a three character 
  899.                         | extension.
  900.                         |
  901.                         | This option will work even if the -E  parameter 
  902.                         | is  not used, but will not work if  -X  (cancel 
  903.                         | file compilation) is called for.
  904.                         |
  905.         -Ofilename.ext  | Using  this parameter will cause  AlphaQBBS  to 
  906.                         | create  a file (filename.ext) of all the  files 
  907.                         | that  it  adopted during  its  operation.  This 
  908.                         | parameter  can  have no effect  unless  the  -A 
  909.                         | option is used.
  910.                         |
  911.  
  912.  
  913.  
  914.  
  915.                                Page 15
  916.  
  917.  
  918.  
  919.         =================================================================
  920.         Section 4.4: Available Command Line Parameters ...continued      
  921.         =================================================================
  922.  
  923.                         |
  924.         -P[Option]      | When  used, AlphaQBBS will attempt  to  provide 
  925.                         | some type of compressed (e.g., PAKed,  ARCIVED, 
  926.                         | etc.,) file compilation. The normal ascii text 
  927.                         | file  output  is still provided.  -P  has  four 
  928.                         | forms as shown:
  929.                         |
  930.                         | -P1 - Use   the   PAK  v1.6  method   of   file             
  931.                         |       compression.
  932.                         | -P2 - Use  Phil  Katz's PKARC  v3.5  method  of          
  933.                         |       file compression.
  934.                         | -P3 - Use  the  New  Phil  Katz's  PKZIP  v0.90       
  935.                         |       method of file compression.  
  936.                         | -P4 - Use   the  ZOO  v1.22  method   of   file       
  937.                         |       compression.
  938.                         | 
  939.                         | AlphaQBBS  knows how to use each of the  listed 
  940.                         | programs for the given version. Other  versions 
  941.                         | of  the  listed  programs may  also  work,  but 
  942.                         | haven't  been tested. When using, just  specify 
  943.                         | "-P[#]". Do NOT specify the compression program 
  944.                         | name.
  945.                         |
  946.                         | If  any  one of the -P options is  used  ,  the 
  947.                         | associated compression program (e.g.,  PAK.EXE) 
  948.                         | must  either  exist in the  same  directory  as 
  949.                         | AlphaQBBS or be listed in a DOS PATH statement.
  950.                         |
  951.         -Q[Path]        | This  allows you to specify in  what  directory 
  952.                         | the  compiled  files  listings  and  compressed 
  953.                         | files listings will go. An example:
  954.                         | 
  955.                         | AlphQBBS -3 -QD:\files\area1\
  956.                         |
  957.                         | Note: The trailing backslash is required!  This 
  958.                         | will save batch file copying and deleting.
  959.                         |
  960.         -Tfilename.ext  | Append  the specified file to end of the  files  
  961.                         | listing.  This may be referred elsewhere  as  a  
  962.                         | "TAG" file. The filename must be legal and have  
  963.                         | a 3-digit extension.  Do not use spaces between  
  964.                         | the  -T and the filename.  There is no  default  
  965.                         | "tag" file.
  966.                         |
  967.         -S              | When  this parameter is specified, ALL  sorting 
  968.                         | of any FILES.BBS is prevented. This is   espec-
  969.                         | ially useful if you run the program more   than 
  970.                         | once  ,in  a  batch file,  to  create  multiple  
  971.                         | listings.   Specifying  this   parameter   will  
  972.                         | increase execution speed dramatically.
  973.                         |
  974.  
  975.  
  976.                                Page 16
  977.  
  978.  
  979.  
  980.         =================================================================
  981.         Section 4.4: Available Command Line Parameters ...continued
  982.         =================================================================
  983.  
  984.                         |
  985.         -X              | This  parameter  allows canceling of  any  file 
  986.                         | compilation.  This is ONLY used if you wish  to 
  987.                         | sort  the  FILES.BBS  and  not  make  a   files 
  988.                         | listing. This could be very useful during  man-
  989.                         | ual files area maintenance.
  990.         -----------------------------------------------------------------
  991.  
  992.         More explanation of option 2:
  993.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  994.  
  995.         -> When this parameter is used, the file creation date is substi-
  996.            tuted  with the area number. Where does this area number  come 
  997.            from? At this time it ISN'T specified in the control file, but 
  998.            is  derived from it. How is that? The FILES.BBS  indicated  on 
  999.            the  first line is assigned area "1". The FILES.BBS  indicated 
  1000.            on the second line is assigned area "2". The FILES.BBS  speci-
  1001.            fied  on the tenth line of the control file is  assigned  area 
  1002.            "10", etc.,
  1003.  
  1004.            As  you might of now guessed, you should create  your  control 
  1005.            file in an orderly manor.
  1006.  
  1007.            Your  header  or tag file should include a little  chart  that 
  1008.            explains  what  each files area number is.  My  "DOWNLOAD.TAG" 
  1009.            file is included in the package as an example.
  1010.  
  1011.  
  1012.  
  1013.         =================================================================
  1014.         Section 4.5: Expiration Data Explained                             
  1015.         =================================================================
  1016.  
  1017.         Expiration Date:
  1018.         ~~~~~~~~~~~~~~~~
  1019.         This  is a Gamma (7.01) version and hence has an expiration  date 
  1020.         of June 30th, 1989. This was done so that old versions would  not 
  1021.         stay in use. When we are sure that the program is absolutely  bug 
  1022.         free  and in a "final version", a copy will be issued without  an 
  1023.         expiration date.
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.                                Page 17
  1038.  
  1039.  
  1040.  
  1041.         =================================================================
  1042.         Section 5: Error Table
  1043.         =================================================================
  1044.  
  1045.  
  1046.  
  1047.         Error return codes and what you should do about it:
  1048.         -----------------------------------------------------------------
  1049.         Err code: | What you should do about it:
  1050.         ----------+------------------------------------------------------
  1051.             6     | There are too many of something; hard to track down
  1052.             7     | Out of memory - get some more
  1053.            24     | Oh-oh, your disk drive!
  1054.            25     | Oh-oh, your disk drive!
  1055.            27     | Printer out of paper - GO TO SLEEP!
  1056.            51     | Internal Error!!!!!!!!
  1057.            52     | Too many devices open, check CONFIG.SYS
  1058.            53     | File missing!!
  1059.            54     | File not accessible
  1060.            55     | Too many devices open, check CONFIG.SYS
  1061.            57     | Oh-oh, your disk drive!
  1062.            58     | Cannot access file
  1063.            61     | Disk full - you'll need an extra
  1064.            62     | Corrupted input file
  1065.            63     | Index file corrupted
  1066.            64     | Control file corrupted or bad command line parameter
  1067.            67     | Directory full - try another one
  1068.            68     | Oh, nasty!  Your disk drive is missing!
  1069.            69     | Don't redirect to the COM port!!!
  1070.            70     | Disk write protected - we can't have that!!!
  1071.            71     | Oh-oh, your disk drive! (not ready)
  1072.            72     | Oh, nasty!  Your disk has a media error!
  1073.            75     | Path/File cannot be accessed
  1074.            76     | Path doesn't exist
  1075.            77     | Oh, nasty!  Dead lock!
  1076.         ----------+------------------------------------------------------
  1077.  
  1078.         This  is every possible error, anything else is just weird or  an 
  1079.         overflow.
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.  
  1088.  
  1089.  
  1090.  
  1091.  
  1092.  
  1093.  
  1094.  
  1095.  
  1096.  
  1097.  
  1098.                                Page 18
  1099.  
  1100.  
  1101.  
  1102.         =================================================================
  1103.         Section 6: Registration
  1104.         =================================================================
  1105.  
  1106.         Registration is to your advantage.  If you register AlphaQBBS 5.0 
  1107.         you will get the following:
  1108.  
  1109.           * Notification of any bug fixes
  1110.           * Possible beta tester status
  1111.           * Get your conscience off your back
  1112.           * Fund a very successful software development group
  1113.           * Get a version without an expiration date
  1114.  
  1115.         If  you  wish to register please send $30.00 cash  or  check  (No 
  1116.         credit cards please) to:
  1117.  
  1118.           K-TECH Computers
  1119.           Box 450
  1120.           Lewistown, PA 17044
  1121.  
  1122.  
  1123.  
  1124.         =================================================================
  1125.         Section 7: Warranties, Licensing, etc.
  1126.         =================================================================
  1127.  
  1128.         WARRANTIES:
  1129.  
  1130.         The  only thing I can guarantee is that the program will take  up 
  1131.         disk space and will access files.  
  1132.  
  1133.         Due to the demand for more recent versions, version 7.0 will  not 
  1134.         last indefinitely.
  1135.  
  1136.         LICENSING:
  1137.  
  1138.         You  can use this program in any way that you wish, but  none  of 
  1139.         the  associated  parties in the development of  the  program  are 
  1140.         responsible for any damage either caused by this program or  not. 
  1141.         This is shareware, not a microwave.
  1142.  
  1143.         =================================================================
  1144.         Section 8: Credits
  1145.         =================================================================
  1146.  
  1147.         COPYRIGHTS:
  1148.  
  1149.         Original AlphaQBBS is Copyright (C) 1988,1989 by K-Tech Computers
  1150.  
  1151.         AlphaQBBS 7.0 is Copyright (C) 1989 by \/isions Software
  1152.  
  1153.         AlphaSetup is Copyright (C) 1989 by \/isions software
  1154.  
  1155.         Vsort is Copyright (C) 1989 by \/Soft and Dimensions Unlimited
  1156.  
  1157.  
  1158.  
  1159.                                Page 19
  1160.  
  1161.  
  1162.  
  1163.         =================================================================
  1164.         Section 8: Credits ...continued                                              
  1165.         =================================================================
  1166.  
  1167.         These documents are Copyright (C) 1989 by \/isions Software
  1168.  
  1169.         \/isions  Software  is Copyright (C) 1989  by  K-Tech  computers, 
  1170.         Dimensions Unlimited (a division of K-Tech), and \/Soft
  1171.  
  1172.         K-Tech Computers is Copyright (C) 1988,1989 by David L. Kuhn
  1173.  
  1174.         \/Soft is Copyright (C) 1988, 1989 by Jason Froikin
  1175.  
  1176.         A  big  thanks  goes to Adam Hudson, the author  of  QuickBBS,  a 
  1177.         bulletin board communications system. 
  1178.  
  1179.         To  the  users of previous versions of this program,  accept  our 
  1180.         adulations. Without you, version 7.0 would not be possible.
  1181.  
  1182.         The sysops of the QuickBBS international echo, where many of  the 
  1183.         ideas for this product came from.
  1184.  
  1185.         No  part of anything included in this package may be  duplicated, 
  1186.         in  part or in whole, without the express written consent of  one 
  1187.         or  both of the parties involved in the production of this  great 
  1188.         project.
  1189.  
  1190.         =================================================================
  1191.                              AlphaQBBS 7.0 Documents
  1192.         =================================================================
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.  
  1218.  
  1219.  
  1220.                                Page 20
  1221.  
  1222.  
  1223.  
  1224.  
  1225.                                 Registration Form
  1226.  
  1227.         +---------------------------------------------------------------+
  1228.         |                                                               |
  1229.         |                                                               |
  1230.         | Your Name:_____________________________       Date:__________ |
  1231.         |                                                               |
  1232.         | Street Address:______________________________________________ |
  1233.         |                                                               |
  1234.         | Your City:___________________________________________________ |
  1235.         |                                                               |
  1236.         | State:___________________________________ ZIP:_______________ |
  1237.         |                                                               |
  1238.         | Country:_____________________________________________________ |
  1239.         |                                                               |
  1240.         | Home Phone (Voice):__________________________________________ |
  1241.         |                                                               |
  1242.         | BBS Name:____________________________________________________ |
  1243.         |                                                               |
  1244.         | BBS Phone Number:____________________________________________ |
  1245.         |                                                               |
  1246.         | Baud Rates Supported:________________________________________ |
  1247.         |                                                               |
  1248.         | Net Node Number (If Applicable):____________________________  |
  1249.         |                                                               |
  1250.         | BBS Software used:___________________________________________ |
  1251.         |                                                               |
  1252.         | Computer Type:_______________________________________________ |
  1253.         |                                                               |
  1254.         | Approximate Number of Files On your BBS:___________________   |
  1255.         |                                                               |
  1256.         | Number of file areas:________________________________________ |
  1257.         |                                                               |
  1258.         | Comments:____________________________________________________ |
  1259.         |                                                               |
  1260.         |          ____________________________________________________ |
  1261.         |                                                               |
  1262.         +---------------------------------------------------------------+
  1263.         |                                                               |
  1264.         | Number of Copies of AlphaQBBS: ______ (Version 7.0)           |
  1265.         |                                                               |
  1266.         |                         Times: $30.00 (each copy)             |
  1267.         |                               ________                        |
  1268.         |                                                               |
  1269.         |                                                               |
  1270.         |                         Total: ______                         |       
  1271.         |                                                               |
  1272.         |                                                               |
  1273.         | Remit to:    K-Tech Computers                                 |
  1274.         |              P.O. Box 450                                     |
  1275.         |              Lewistown, PA 17044                              |
  1276.         |                                                               |
  1277.         +---------------------------------------------------------------+
  1278.  
  1279.  
  1280.  
  1281.                                Page 21
  1282.